@clerk/clerk-js
Advanced tools
ClerkJS is our foundational JavaScript library for building user management and authentication. It enables you to register, sign in, verify and manage users for your application using highly customizable flows.
There are two ways you can include ClerkJS in your project. You can either import the ClerkJS npm module or load ClerkJS with a script tag.
npm install @clerk/clerk-js
Once you have installed the package, you will need to import the ClerkJS object constructor into your code and pass it your Frontend API as a parameter.
import Clerk from '@clerk/clerk-js';
const clerkFrontendApi = 'pk_[publishable_key]';
const clerk = new Clerk(clerkFrontendApi);
await clerk.load({
// Set load options here...
});
ClerkJS can be loaded from a <script /> tag with the source from your Frontend API URL.
Add the following script to your site's <body> element:
<script>
// Get this URL and Publishable Key from the Clerk Dashboard
const clerkFrontendApi = 'pk_[publishable_key]';
const frontendApi = '[your-domain].clerk.accounts.dev';
const version = '@latest'; // Set to appropriate version
// Creates asynchronous script
const script = document.createElement('script');
script.setAttribute('data-clerk-frontend-api', frontendApi);
script.setAttribute('data-clerk-publishable-key', clerkFrontendApi);
script.async = true;
script.src = `https://${frontendApi}/npm/@clerk/clerk-js${version}/dist/clerk.browser.js`;
// Adds listener to initialize ClerkJS after it's loaded
script.addEventListener('load', async function () {
await window.Clerk.load({
// Set load options here...
});
});
document.body.appendChild(script);
</script>
To build the package locally with Webpack, run:
npm run build
<h1>Hello Clerk!</h1>
<button
id="sign-in-button"
onclick="Clerk.openSignIn()"
>
Sign In
</button>
<div id="user-button"></div>
<script>
async function loadClerk() {
const userButton = document.getElementById('user-button');
const signInButton = document.getElementById('sign-in-button');
await window.Clerk.load();
if (Clerk.user) {
Clerk.mountUserButton(userButton);
signInButton.hidden = true;
}
}
// [...] Installation code
</script>
For further details and examples, please refer to our Documentation.
You can get in touch with us in any of the following ways:
We're open to all community contributions! If you'd like to contribute in any way, please read our contribution guidelines.
@clerk/clerk-js follows good practices of security, but 100% security cannot be assured.
@clerk/clerk-js is provided "as is" without any warranty. Use at your own risk.
For more information and to report security issues, please refer to our security documentation.
This project is licensed under the MIT license.
See LICENSE for more information.
FAQs
Clerk JS library
The npm package @clerk/clerk-js receives a total of 30,519 weekly downloads. As such, @clerk/clerk-js popularity was classified as popular.
We found that @clerk/clerk-js demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 8 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.
Security News
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.